﻿#region License
// Copyright 2007-2008 Rory Plaire (codekaizen@gmail.com)
/*
 * This license governs use of the accompanying software. If you use the software, you
 * accept this license. If you do not accept the license, do not use the software.
 * 
 * 1. Definitions
 * The terms "reproduce," "reproduction," "derivative works," and "distribution" have the
 * same meaning here as under U.S. copyright law.
 * A "contribution" is the original software, or any additions or changes to the software.
 * A "contributor" is any person that distributes its contribution under this license.
 * "Licensed patents" are a contributor's patent claims that read directly on its contribution.
 * 
 * 2. Grant of Rights
 * (A) Copyright Grant- Subject to the terms of this license, including the license conditions 
 *     and limitations in section 3, each contributor grants you a non-exclusive, worldwide, 
 *     royalty-free copyright license to reproduce its contribution, prepare derivative works 
 *     of its contribution, and distribute its contribution or any derivative works that you create.
 * (B) Patent Grant- Subject to the terms of this license, including the license conditions and 
 *     limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free 
 *     license under its licensed patents to make, have made, use, sell, offer for sale, import, 
 *     and/or otherwise dispose of its contribution in the software or derivative works of the 
 *     contribution in the software.
 * 
 * 3. Conditions and Limitations
 * (A) No Trademark License- This license does not grant you rights to use any contributors' 
 *     name, logo, or trademarks.
 * (B) If you bring a patent claim against any contributor over patents that you claim are 
 *     infringed by the software, your patent license from such contributor to the software 
 *     ends automatically.
 * (C) If you distribute any portion of the software, you must retain all copyright, patent, 
 *     trademark, and attribution notices that are present in the software.
 * (D) If you distribute any portion of the software in source code form, you may do so only under 
 *     this license by including a complete copy of this license with your distribution. If you 
 *     distribute any portion of the software in compiled or object code form, you may only do so 
 *     under a license that complies with this license.
 * (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no 
 *     express warranties, guarantees or conditions. You may have additional consumer rights under 
 *     your local laws which this license cannot change. To the extent permitted under your local laws, 
 *     the contributors exclude the implied warranties of merchantability, fitness for a particular 
 *     purpose and non-infringement.
 * 
 */
#endregion

using System;

namespace NPack.Interfaces
{
    /// <summary>
    /// An interface to an affine transformation matrix.
    /// </summary>
    /// <typeparam name="TComponent">Type of element in the matrix.</typeparam>
    /// <typeparam name="TVector">Type of vector.</typeparam>
    /// <typeparam name="TMatrix">Type of matrix.</typeparam>
    public interface IAffineTransformMatrix<TComponent, TVector, TMatrix> : ITransformMatrix<TComponent, TVector, TMatrix>
        where TComponent : IEquatable<TComponent>, IComparable<TComponent>, 
                           IComputable<TComponent>, IConvertible, IFormattable
        where TVector : IVector<TComponent, TVector>,
                        IEquatable<TVector>, IComparable<TVector>,
                        IComputable<Double, TVector>
        where TMatrix : IMatrix<TComponent, TMatrix>, 
                        IEquatable<TMatrix>, IComparable<TMatrix>, IComputable<TMatrix>
    {
        /// <summary>
        /// Gets the inverse of the affine transform.
        /// </summary>
        new TMatrix Inverse { get; }    

        /// <summary>
        /// Resets the affine transform to the identity matrix (a diagonal of one).
        /// </summary>
        void Reset();

        /// <summary>
        /// Rotates the affine transform around the given <paramref name="axis"/> 
        /// at the given <paramref name="point"/>.
        /// </summary>
        /// <param name="point">Point at which to compute the rotation.</param>
        /// <param name="axis">The axis to rotate around.</param>
        /// <param name="radians">Angle to rotate through.</param>
        void RotateAt(TVector point, TVector axis, Double radians);

        /// <summary>
        /// Rotates the affine transform around the given <paramref name="axis"/> 
        /// at the given <paramref name="point"/>.
        /// </summary>
        /// <param name="point">Point at which to compute the rotation.</param>
        /// <param name="axis">The axis to rotate around.</param>
        /// <param name="radians">Angle to rotate through.</param>
        /// <param name="order">Order in which to apply the operation.</param>
        void RotateAt(TVector point, TVector axis, Double radians, MatrixOperationOrder order);

        /// <summary>
        /// Translates the affine transform by the given amount in each dimension.
        /// </summary>
        /// <param name="amount">Amount to translate by.</param>
        void Translate(TComponent amount);

        /// <summary>
        /// Translates the affine transform by the given amount in each dimension.
        /// </summary>
        /// <param name="amount">Amount to translate by.</param>
        /// <param name="order">Order in which to apply the operation.</param>
        void Translate(TComponent amount, MatrixOperationOrder order);

        /// <summary>
        /// Translates the affine transform by the given translation vector.
        /// </summary>
        /// <param name="translateVector">
        /// A vector whose components will translate the transform 
        /// in the corresponding dimension.
        /// </param>
        void Translate(TVector translateVector);

        /// <summary>
        /// Translates the affine transform by the given translation vector.
        /// </summary>
        /// <param name="translateVector">
        /// A vector whose components will translate the transform 
        /// in the corresponding dimension.
        /// </param>
        /// <param name="order">Order in which to apply the operation.</param>
        void Translate(TVector translateVector, MatrixOperationOrder order);
    }
}
